package com.wjk.kylin.config.web;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author wangjkui
 * @description Swagger2Config
 * @date 2020/5/22
 */
@Configuration
@EnableSwagger2
@Profile({"local","dev"})
public class Swagger2Config {

//     @Api 修饰整个类，描述Controller的作用
//     @ApiOperation 描述一个类的一个方法，或者说一个接口
//     @ApiParam 单个参数描述
//     @ApiModel 用对象来接收参数
//     @ApiProperty 用对象接收参数时，描述对象的一个字段
//     @ApiResponse HTTP响应其中1个描述
//     @ApiResponses HTTP响应整体描述
//     @ApiIgnore 使用该注解忽略这个API
//     @ApiError： 发生错误返回的信息
//     @ApiImplicitParam 一个请求参数
//     @ApiImplicitParams 多个请求参数
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))   //这里采用包含注解的方式来确定要显示的接口
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("麒麟管理系统")
                .description("麒麟管理系统文档")
                .termsOfServiceUrl("https://gitee.com/wangjkui/kylin-admin")
                .contact(new Contact("WangJKui", "https://gitee.com/wangjkui/kylin-admin", "453091806@qq.ocm"))
                .version("1.0.0")
                .build();
    }

}